Improve docs. (#62359)
authorMatthias Clasen <matthiasc@src.gnome.org>
Tue, 23 Apr 2002 22:22:44 +0000 (22:22 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Tue, 23 Apr 2002 22:22:44 +0000 (22:22 +0000)
* gtk/gtktextview.c (gtk_text_view_buffer_to_window_coords):
(gtk_text_view_window_to_buffer_coords): Improve docs.  (#62359)

* gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml: Updates.  (#79001)

* gtk/tmpl/gtksocket.sgml: Add link to XEmbed draft.  (#67818)

* gtk/tmpl/gtkdrawingarea.sgml: Fix a typo.

* gtk/text_widget.sgml: Complete the fix for #79080.

12 files changed:
ChangeLog
ChangeLog.pre-2-10
ChangeLog.pre-2-2
ChangeLog.pre-2-4
ChangeLog.pre-2-6
ChangeLog.pre-2-8
docs/reference/ChangeLog
docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml
docs/reference/gtk/text_widget.sgml
docs/reference/gtk/tmpl/gtkdrawingarea.sgml
docs/reference/gtk/tmpl/gtksocket.sgml
gtk/gtktextview.c

index cf0857726429340902e24b834ed46c02676571dc..8d3d1da015b17453393c30e77d8072dab5aeeae9 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2002-04-23  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtktextview.c (gtk_text_view_buffer_to_window_coords): 
+       (gtk_text_view_window_to_buffer_coords): Improve docs.  (#62359)
+
 Tue Apr 23 18:35:34 2002  Kristian Rietveld  <kris@gtk.org>
 
        This commit adds a cell_background property for cell renderers. With
index cf0857726429340902e24b834ed46c02676571dc..8d3d1da015b17453393c30e77d8072dab5aeeae9 100644 (file)
@@ -1,3 +1,8 @@
+2002-04-23  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtktextview.c (gtk_text_view_buffer_to_window_coords): 
+       (gtk_text_view_window_to_buffer_coords): Improve docs.  (#62359)
+
 Tue Apr 23 18:35:34 2002  Kristian Rietveld  <kris@gtk.org>
 
        This commit adds a cell_background property for cell renderers. With
index cf0857726429340902e24b834ed46c02676571dc..8d3d1da015b17453393c30e77d8072dab5aeeae9 100644 (file)
@@ -1,3 +1,8 @@
+2002-04-23  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtktextview.c (gtk_text_view_buffer_to_window_coords): 
+       (gtk_text_view_window_to_buffer_coords): Improve docs.  (#62359)
+
 Tue Apr 23 18:35:34 2002  Kristian Rietveld  <kris@gtk.org>
 
        This commit adds a cell_background property for cell renderers. With
index cf0857726429340902e24b834ed46c02676571dc..8d3d1da015b17453393c30e77d8072dab5aeeae9 100644 (file)
@@ -1,3 +1,8 @@
+2002-04-23  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtktextview.c (gtk_text_view_buffer_to_window_coords): 
+       (gtk_text_view_window_to_buffer_coords): Improve docs.  (#62359)
+
 Tue Apr 23 18:35:34 2002  Kristian Rietveld  <kris@gtk.org>
 
        This commit adds a cell_background property for cell renderers. With
index cf0857726429340902e24b834ed46c02676571dc..8d3d1da015b17453393c30e77d8072dab5aeeae9 100644 (file)
@@ -1,3 +1,8 @@
+2002-04-23  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtktextview.c (gtk_text_view_buffer_to_window_coords): 
+       (gtk_text_view_window_to_buffer_coords): Improve docs.  (#62359)
+
 Tue Apr 23 18:35:34 2002  Kristian Rietveld  <kris@gtk.org>
 
        This commit adds a cell_background property for cell renderers. With
index cf0857726429340902e24b834ed46c02676571dc..8d3d1da015b17453393c30e77d8072dab5aeeae9 100644 (file)
@@ -1,3 +1,8 @@
+2002-04-23  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtktextview.c (gtk_text_view_buffer_to_window_coords): 
+       (gtk_text_view_window_to_buffer_coords): Improve docs.  (#62359)
+
 Tue Apr 23 18:35:34 2002  Kristian Rietveld  <kris@gtk.org>
 
        This commit adds a cell_background property for cell renderers. With
index 6cead5e3078c6ddefc3f91583e5d3312796118dc..d67f9be36ff6670cf6d39d31c74e91e373f4ca51 100644 (file)
@@ -1,3 +1,15 @@
+2002-04-24  Matthias Clasen  <maclas@gmx.de>
+
+       * gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml: Updates.  (#79001)
+
+2002-04-23  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/tmpl/gtksocket.sgml: Add link to XEmbed draft.  (#67818)
+
+       * gtk/tmpl/gtkdrawingarea.sgml: Fix a typo.
+
+       * gtk/text_widget.sgml: Complete the fix for #79080.
+
 2002-04-22  Matthias Clasen  <maclas@gmx.de>
 
        * gtk/tree_widget.sgml: Fix typo in "Simple Example".  (#78661)
index acdebe537cf2ed4bf4651baf48a8503752fc5f01..dbdfa95c200addcbced99cec51e76cb0b362855a 100644 (file)
@@ -10,7 +10,8 @@ Application-driven progressive image loading.
     process of loading an image, by letting them send the image data
     directly to the loader instead of having the loader read the data
     from a file.  Applications can use this functionality instead of
-    gdk_pixbuf_new_from_file() when they need to parse image data in
+    gdk_pixbuf_new_from_file() or gdk_pixbuf_animation_new_from_file() 
+    when they need to parse image data in
     small chunks.  For example, it should be used when reading an
     image from a (potentially) slow network connection, or when
     loading an extremely large file.
@@ -47,31 +48,18 @@ Application-driven progressive image loading.
     <title>Loading an animation</title>
 
     <para>
-      Loading an animation is a little more complex then loading an
-      image.  In addition to the above signals, there is also a "<link
-      linkend="GdkPixbufLoader-frame-done">frame_done</link>" signal,
-      as well as an "<link
-      linkend="GdkPixbufLoader-animation-done">animation_done</link>"
-      signal.  The first lets the application know that it is dealing
-      with an animation, instead of a static image.  It also passes a
-      #GdkPixbufFrame in the signal.  As before, if you want to keep
-      the frame, you need to ref it.  Once the first "<link
-      linkend="GdkPixbufLoader-frame-done">frame_done</link>" signal
+      Loading an animation is almost as easy as loading an
+      image.  Once the first "<link
+      linkend="GdkPixbufLoader-area-prepared">area_prepared</link>" signal
       has been emitted, you can call gdk_pixbuf_loader_get_animation()
-      to get the #GdkPixbufAnimation struct.  Each subsequent frame
-      goes through a similar lifecycle.  For example "<link
-      linkend="GdkPixbufLoader-area-prepared">area_prepared</link>" is
-      re-emitted.  Then "<link
-      linkend="GdkPixbufLoader-area-updated">area_updated</link>" is
-      emitted as many times as necessary.  Finally, "<link
-      linkend="GdkPixbufLoader-animation-done">animation_done</link>"
-      is emitted as soon as all frames are done.
+      to get the #GdkPixbufAnimation struct and gdk_pixbuf_animation_get_iter()
+      to get an #GdkPixbufAnimationIter for displaying it. 
     </para>
   </refsect2>
 
 <!-- ##### SECTION See_Also ##### -->
   <para>
-    gdk_pixbuf_new_from_file()
+    gdk_pixbuf_new_from_file(), gdk_pixbuf_animation_new_from_file()
   </para>
 
 <!-- ##### FUNCTION gdk_pixbuf_loader_new ##### -->
index d703456d199701cd985e01285cba7bd245221e1e..ca015bcd51fec1f8394499f3d0879090715a73d1 100644 (file)
@@ -162,7 +162,7 @@ font and foreground color &mdash use standard
 functions such as 
 <link linkend="gtk-widget-modify-font">gtk_widget_modify_font()</link>
 or 
-<link linkend="gtk-widget-modify-fg">gtk_widget_modify_fg()</link>.
+<link linkend="gtk-widget-modify-fg">gtk_widget_modify_text()</link>.
 For other attributes there are dedicated methods on 
 <link linkend="GtkTextView">GtkTextView</link> such as 
 <link linkend="gtk-text-view-set-tabs">gtk_text_view_set_tabs()</link>.
index 9757c2a863eff1f3d2043d155a4e257a201e9140..653c27ccfad58f2468e5bdf8aebef61b9e644abf 100644 (file)
@@ -53,7 +53,7 @@ that drawing is implicitly clipped to the exposed area.
 <title>Simple <structname>GtkDrawingArea</structname> usage.</title>
 <programlisting>
 gboolean
-expose_event_callback (GdkWidget *widget, GdkEventExpose *event, gpointer data)
+expose_event_callback (GtkWidget *widget, GdkEventExpose *event, gpointer data)
 {
   gdk_draw_arc (widget->window,
                 widget->style->fg_gc[GTK_WIDGET_STATE (widget)],
index 38e6fe9fd99646586fe0e4701b520f033c001b1a..be5e1b19f1a6d3b2603510e2e27d504b0399a0e7 100644 (file)
@@ -62,12 +62,21 @@ to be destroyed at any time when the main event loop
 is running.
 </para>
 
+<para>
+The communication between a #GtkSocket and a #GtkPlug follows the 
+<ulink url="http://www.freedesktop.org/standards/xembed.html">XEmbed</ulink>
+protocol. This protocol has also been implemented in other toolkits, e.g.  
+<application>Qt</application>, allowing the same level of integration
+when embedding a <application>Qt</application> widget in GTK or vice versa.</para>
+
 <para>
 A socket can also be used to swallow arbitrary 
 pre-existing top-level windows using gtk_socket_steal(),
 though the integration when this is done will not be as close
 as between a #GtkPlug and a #GtkSocket.</para>
 
+</para>
+
 <!-- ##### SECTION See_Also ##### -->
 <para>
 <variablelist>
@@ -77,6 +86,11 @@ as between a #GtkPlug and a #GtkSocket.</para>
 <listitem><para>the widget that plugs into a #GtkSocket.</para></listitem>
 </varlistentry>
 
+<varlistentry>
+<term><ulink url="http://www.freedesktop.org/standards/xembed.html">XEmbed</ulink></term>
+<listitem><para>the XEmbed Protocol Specification.</para></listitem>
+</varlistentry>
+
 </variablelist>
 </para>
 
index 676f732b35e15ef5f79252d1d542332bcb99b52f..63a34e75fabae3b3e788e6317d2208e85d140146 100644 (file)
@@ -6845,14 +6845,17 @@ buffer_to_text_window (GtkTextView   *text_view,
 /**
  * gtk_text_view_buffer_to_window_coords:
  * @text_view: a #GtkTextView
- * @win: a #GtkTextWindowType
+ * @win: a #GtkTextWindowType except #GTK_TEXT_WINDOW_PRIVATE
  * @buffer_x: buffer x coordinate
  * @buffer_y: buffer y coordinate
  * @window_x: window x coordinate return location
  * @window_y: window y coordinate return location
  *
  * Converts coordinate (@buffer_x, @buffer_y) to coordinates for the window
- * @win, and stores the result in (@window_x, @window_y).
+ * @win, and stores the result in (@window_x, @window_y). 
+ *
+ * Note that you can't convert coordinates for a nonexisting window (see 
+ * gtk_text_view_set_border_window_size()).
  **/
 void
 gtk_text_view_buffer_to_window_coords (GtkTextView      *text_view,
@@ -6982,7 +6985,7 @@ text_window_to_buffer (GtkTextView   *text_view,
 /**
  * gtk_text_view_window_to_buffer_coords:
  * @text_view: a #GtkTextView
- * @win: a #GtkTextWindowType
+ * @win: a #GtkTextWindowType except #GTK_TEXT_WINDOW_PRIVATE
  * @window_x: window x coordinate
  * @window_y: window y coordinate
  * @buffer_x: buffer x coordinate return location
@@ -6990,6 +6993,9 @@ text_window_to_buffer (GtkTextView   *text_view,
  *
  * Converts coordinates on the window identified by @win to buffer
  * coordinates, storing the result in (@buffer_x,@buffer_y).
+ *
+ * Note that you can't convert coordinates for a nonexisting window (see 
+ * gtk_text_view_set_border_window_size()).
  **/
 void
 gtk_text_view_window_to_buffer_coords (GtkTextView      *text_view,